Skip to main content

Get-IMAuthSession

SYNOPSIS​

Retrieves authenticated sessions from Immich

SYNTAX​

Get-IMAuthSession [[-Session] <ImmichSession>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

DESCRIPTION​

Retrieves information about all currently active authenticated sessions in Immich. This includes sessions from web browsers, mobile apps, and API clients.

EXAMPLES​

EXAMPLE 1​

Get-IMAuthSession

Retrieves all active authenticated sessions.

EXAMPLE 2​

$sessions = Get-IMAuthSession
$sessions | Where-Object {$_.deviceType -eq 'mobile'}

Retrieves sessions and filters for mobile device sessions.

EXAMPLE 3​

Get-IMAuthSession | Format-Table deviceType, createdAt, current

Displays session information in a formatted table.

PARAMETERS​

-Session​

Optionally define an Immich session object to use. This is useful when you are connected to more than one Immich instance.

Type: ImmichSession
Parameter Sets: (All)
Aliases:

Required: False
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ProgressAction​

{{ Fill ProgressAction Description }}

Type: ActionPreference
Parameter Sets: (All)
Aliases: proga

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters​

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS​

OUTPUTS​

NOTES​

Due to Get-IMSession already being used by the PSImmich module, cmdlets within the session namespace are prefixed with 'Auth'.

EDIT THIS DOC​

This page was auto-generated from the powershell command comment based help. To edit the content of this page, update the script file comment based help on github Github